<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>spade.tbcbp.TBCBP</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spade2.googlecode.com">SPADE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="spade-module.html">Package&nbsp;spade</a> ::
        <a href="spade.tbcbp-module.html">Module&nbsp;tbcbp</a> ::
        Class&nbsp;TBCBP
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="spade.tbcbp.TBCBP-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TBCBP</h1><p class="nomargin-top"><span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP">source&nbsp;code</a></span></p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">rl</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">limit</code><code class="variable-quote">'</code><code class="variable-op">: </code>10000<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">maxth</code><code class="variable-quote">'</code><code class="variable-op">: </code>0.95<code class="variable-group">}</code></span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getCaseTime"></a><span class="summary-sig-name">getCaseTime</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">case</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getCaseTime">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="registerService"></a><span class="summary-sig-name">registerService</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">service</span>,
        <span class="summary-sig-arg">time</span>=<span class="summary-sig-default">1</span>,
        <span class="summary-sig-arg">QoS</span>=<span class="summary-sig-default">1</span>)</span><br />
      registers a DF.Service time and QoS parameters are optional</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.registerService">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="delService"></a><span class="summary-sig-name">delService</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.delService">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getService"></a><span class="summary-sig-name">getService</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      returns a DF.Service</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getService">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getServiceInfo"></a><span class="summary-sig-name">getServiceInfo</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      returns info of a service Usage: name - string with the name of the 
      service returns a dict with the info of the service</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getServiceInfo">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="addCase"></a><span class="summary-sig-name">addCase</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">case</span>)</span><br />
      inserts a new case in the case-base services of the case MUST be 
      registered in the TBCBP</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.addCase">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="addPlan"></a><span class="summary-sig-name">addPlan</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">plan</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.addPlan">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.tbcbp.TBCBP-class.html#getCases" class="summary-sig-name">getCases</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">P</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">Q</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">inputs</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">outputs</span>=<span class="summary-sig-default">None</span>)</span><br />
      returns a list of cases where the P,Q,inputs and outputs match.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getCases">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getCase"></a><span class="summary-sig-name">getCase</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">case</span>)</span><br />
      returns the case of the case-base whose parameters (P,Q,inputs and 
      outputs) match with the 'case' parameters</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getCase">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getCaseOfService"></a><span class="summary-sig-name">getCaseOfService</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      returns the case that represents the service 'name' in the case-base 
      Usage: name - string with the name of the service</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getCaseOfService">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.tbcbp.TBCBP-class.html#planMatchesInKB" class="summary-sig-name">planMatchesInKB</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">case</span>,
        <span class="summary-sig-arg">kb</span>)</span><br />
      returns True if all the Preconditions and Inputs of the case are true
      in the knowledge-base otherwise returns False Usage: case - the case 
      that we want to compare.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.planMatchesInKB">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="composePlan"></a><span class="summary-sig-name">composePlan</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">Goal</span>,
        <span class="summary-sig-arg">kb</span>,
        <span class="summary-sig-arg">tout</span>=<span class="summary-sig-default">20</span>,
        <span class="summary-sig-arg">use_rl</span>=<span class="summary-sig-default">True</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.composePlan">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="retain"></a><span class="summary-sig-name">retain</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">case</span>,
        <span class="summary-sig-arg">QoS</span>=<span class="summary-sig-default">None</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.retain">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="reward"></a><span class="summary-sig-name">reward</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">c</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.reward">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="punish"></a><span class="summary-sig-name">punish</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">c</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.punish">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="getCases"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getCases</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">P</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">Q</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">inputs</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">outputs</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.getCases">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>returns a list of cases where the P,Q,inputs and outputs match. it 
  only compares parameters if they are not None</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="planMatchesInKB"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">planMatchesInKB</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">case</span>,
        <span class="sig-arg">kb</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.tbcbp-pysrc.html#TBCBP.planMatchesInKB">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>returns True if all the Preconditions and Inputs of the case are true 
  in the knowledge-base otherwise returns False Usage: case - the case that
  we want to compare. instance of Case kb   - the knowledge base of the 
  agent. instance of kb.KB</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spade2.googlecode.com">SPADE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Aug  1 18:44:56 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
